home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / bbs_util / bday117.zip / BIRTHDAY.DOC < prev    next >
Text File  |  1994-06-29  |  21KB  |  437 lines
  1. ┌────────────────────────────────────────────────────────────────────────────┐
  2. │─═══════────══──═══════──══════════──══────══──═══════──────════───══────══─│
  3. │─══────══───══──══────══─────══──────══────══──══────══────══──══───══──══──│
  4. │─══────══───══──══────══─────══──────══────══──══─────══──══────══───════───│
  5. │─════════───══──═══════──────══──────════════──══─────══──════════────══────│
  6. │─══─────══──══──══───══──────══──────══────══──══─────══──══────══────══────│
  7. │─══─────══──══──══────══─────══──────══────══──══────══───══────══────══────│
  8. │─════════───══──══────══─────══──────══────══──═══════────══────══────══────│
  9. │                                                                            │
  10. │                               Birthday v1.17                               │
  11. │                    Copyright (c) 1992-1994 by Cris McRae                   │
  12. │                            All Rights Reserved                             │
  13. │                                                                            │
  14. │                        A Birthday List Generator for                       │
  15. │                           WWIV v4.22+ BBS Systems                          │
  16. │                                                                            │
  17. └────────────────────────────────────────────────────────────────────────────┘
  18.  
  19. ┌────────────────────────────────────────────────────────────────────────────┐
  20. │░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  21. └────────────────────────────────────────────────────────────────────────────┘
  22.  
  23. What is Birthday v1.17?  It is a program written for WWIV v4.22+ BBS systems,
  24. and it generates a listing of users with birthdays on the current date, the
  25. the day before, and the day after.  Here is a sample file output:
  26.  
  27.            Birthday v1.17 [Unregistered] (c) 1992-1994 by Cris McRae
  28.                          Birthday Listing for 09/18/93
  29.  
  30.         YESTERDAY                    TODAY                    TOMORROW
  31. ─────────────────────────  ─────────────────────────  ─────────────────────────
  32.                            JAFO                       The Painter
  33.                            Phantom Of The Opera       De Bug
  34.                            Pix
  35.                            Iceman
  36.  
  37. I changed my system date to my birthday to generate the above listing.  It is
  38. nice to know who has the same birthday as you.  Generally, you run it once a
  39. day in your daily event batch file.
  40.  
  41. Birthday also supports the TODAY.xxx data files which are widely available.
  42. If you have these files, and wish to have them included in the Birthday lists,
  43. Birthday will print out all celebrity birthdays for the current date.
  44.  
  45. Birthday can be used to generate lists for your G-files area, but beginning
  46. with Birthday v1.10, it can also be used as a logon event.  If a user happens
  47. to log onto the BBS on their birthday, a nice Happy Birthday message is
  48. printed out to them.  You may edit the BDAY.* files to display any message you
  49. like, as long as they use WWIV ANSI codes.  The BDAY.* files must go in the
  50. same directory where the BIRTHDAY.EXE is located.
  51.  
  52. ┌────────────────────────────────────────────────────────────────────────────┐
  53. │░░░░ PROGRAM AUTHENTICITY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  54. └────────────────────────────────────────────────────────────────────────────┘
  55.  
  56. Birthday has been archived with PKWARE's PKZIP 2.04g using Authenticity
  57. Verification.  When you unzip the archive, you should see "-AV" displayed
  58. after every file name.  When completed, a message that looks like this will
  59. be displayed:
  60.  
  61. Authentic files Verified!   # KRK282
  62. Cris McRae
  63.  
  64. If this authenticity statement is not displayed, or the authenticity code is
  65. not "KRK282", then you have a copy of Birthday that has been tampered with.
  66. Do >not< use any of the files contained within a tampered archive, as they
  67. may contain viruses, trojans, or other harmful things.
  68.  
  69. Birthday has also been encrypted by a powerful encryption program.  If the
  70. executable file is tampered with, it will display a CRC warning and will not
  71. run.
  72.  
  73. ┌────────────────────────────────────────────────────────────────────────────┐
  74. │░░░░ UPGRADING FROM PREVIOUS VERSIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  75. └────────────────────────────────────────────────────────────────────────────┘
  76.  
  77. If you are upgrading from Birthday v1.16 or below, you >must< run BDAYCFG.EXE
  78. prior to running BIRTHDAY.EXE.  This is required because the BIRTHDAY.CFG file
  79. is no longer used, and BIRTHDAY.EXE will convert your BIRTHDAY.CFG to the new
  80. WWIV.INI format.
  81.  
  82. Failure to run BDAYCFG.EXE prior to running BIRTHDAY.EXE will result in
  83. Birthday running with a default configuration.  If you're registered, it will
  84. also run in unregistered mode.
  85.  
  86. Of course, you should also copy the new BIRTHDAY.EXE over the old one.
  87.  
  88. ┌────────────────────────────────────────────────────────────────────────────┐
  89. │░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  90. └────────────────────────────────────────────────────────────────────────────┘
  91.  
  92. To install Birthday v1.17, you must unzip BDAY117.ZIP to your main WWIV BBS
  93. directory.  Here is what should be included in the archive:
  94.  
  95.     BIRTHDAY.DOC - Birthday v1.17 documentation file
  96.     BIRTHDAY.EXE - Birthday v1.17 executable file
  97.     BDAYCFG .EXE - Birthday v1.17 configuration program
  98.     BDAY    .ANS - Birthday v1.17 Happy Birthday ANSI file
  99.     BDAY    .MSG - Birthday v1.17 Happy Birthday ASCII file
  100.     REGISTER.TXT - Birthday v1.17 registration form
  101.     TODAY   .LCL - Sample TODAY.LCL file
  102.     FILE_ID .DIZ - File description
  103.  
  104. ══[ CONFIGURATION FILE SETUP ]════════════════════════════════════════════════
  105.  
  106. Birthday comes with a configuration program called BDAYCFG.EXE.  It is used
  107. to edit all aspects of Birthdays's operation.  All configuration info used by
  108. Birhtday is stored in WWIV.INI.  This file is not unique to Birthday, so you
  109. may or may not already have one.  If you do, BDAYCFG.EXE will simply append
  110. to the file, otherwise it will create it from scratch.  In either case, a new
  111. section called "[Birthday]" will be added at the end of WWIV.INI.
  112.  
  113. The following is a description of each of the lines used by Birthday for it's
  114. configuration.  In most cases, you will never need to manually change any of
  115. these lines in WWIV.INI, since the Birthday Configuration program (BDAYCFG)
  116. is used to change the values.
  117.  
  118. ASCII_PATH      =C:\WWIV\GFILES   ; Path for your ASCII Birthday list.  If you
  119.                                   ; don't want to generate this file, leave
  120.                                   ; blank.
  121. ANSI_PATH       =C:\WWIV\GFILES   ; Path for your ANSI Birthday list.  If you
  122.                                   ; don't want to generate this file, leave
  123.                                   ; blank.
  124. TODAY_PATH      =C:\WWIV\GFILES   ; Path for your "TODAY.xxx" files.  If you
  125.                                   ; don't want to use these files, leave
  126.                                   ; blank.
  127. CLEAR_SCREEN    =Yes              ; For logon event.  Do you want to clear the
  128.                                   ; screen before displaying Birthday list?
  129. PAUSE_SCREEN    =Yes              ; For logon event.  Do you want to pause the
  130.                                   ; screen after Birthday list is displayed?
  131. ALLOW_ABORT     =Yes              ; For logon event.  Allow users to abort the
  132.                                   ; displaying of the Birthday list?
  133. SHOW_ONLY_ONCE  =No               ; For logon event.  Do you want to display
  134.                                   ; the Birthday list on user's first logon
  135.                                   ; only?
  136. SAVE_BLANK_LISTS=No               ; Display "No User Birthdays" in Birthday
  137.                                   ; list if there are no birthdays for all
  138.                                   ; three days?
  139. SHOW_BLANK_LISTS=No               ; For logon event.  Do you want the Birthday
  140.                                   ; list displayed if there are no birthdays?
  141.                                   ; This option is useless if you use the
  142.                                   ; TODAY.xxx files.
  143. ADD_USER_NUMBERS=No               ; Add user number after user name in
  144.                                   ; Birthday listings?
  145. HEADER_STYLE    =1                ; Header style (1-11, 11 for custom).  A
  146.                                   ; list of available headers is provided in
  147.                                   ; the next section of this document.
  148.                                   ; If you want a custom header, use
  149.                                   ; HEADER.TXT and put a 25 character string
  150.                                   ; in it.
  151. LIST_COLORS     =3,2,5,7,1,2,1    ; Colors for the Birthday lists.  (0-9)
  152.                                   ; Color 1 - Birthday copyright notice
  153.                                   ; Color 2 - Birthday Listing Date
  154.                                   ; Color 3 - YESTERDAY, TODAY, & TOMORROW
  155.                                   ; Color 4 - Separator lines
  156.                                   ; Color 5 - User names
  157.                                   ; Color 6 - "Celebrities born..." line
  158.                                   ; Color 7 - Celebrity names
  159.  
  160. If you are using WWIV v4.22, colors 8 and 9 won't be available unless you have
  161. modified your source.  They are available in WWIV v4.23.
  162.  
  163. ══[ SAMPLE HEADERS ]══════════════════════════════════════════════════════════
  164.  
  165. 1.
  166.         YESTERDAY                    TODAY                    TOMORROW
  167. ─────────────────────────  ─────────────────────────  ─────────────────────────
  168.  
  169. 2.
  170.         YESTERDAY                    TODAY                    TOMORROW
  171. -=-=-=-=-=-=-=-=-=-=-=-=-  -=-=-=-=-=-=-=-=-=-=-=-=-  -=-=-=-=-=-=-=-=-=-=-=-=-
  172.  
  173. 3.
  174.         YESTERDAY                    TODAY                    TOMORROW
  175. ~~~~~~~~~~~~~~~~~~~~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~
  176.  
  177. 4.
  178.         YESTERDAY                    TODAY                    TOMORROW
  179. =========================  =========================  =========================
  180.  
  181. 5.
  182.         YESTERDAY                    TODAY                    TOMORROW
  183. ═════════════════════════  ═════════════════════════  ═════════════════════════
  184.  
  185. 6.
  186.         YESTERDAY                    TODAY                    TOMORROW
  187. ≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈  ≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈  ≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈≈
  188.  
  189. 7.
  190.         YESTERDAY                    TODAY                    TOMORROW
  191. ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  192.  
  193. 8.
  194.         YESTERDAY                    TODAY                    TOMORROW
  195. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  196.  
  197. 9.
  198.         YESTERDAY                    TODAY                    TOMORROW
  199. ««««««««««««*»»»»»»»»»»»»  ««««««««««««*»»»»»»»»»»»»  ««««««««««««*»»»»»»»»»»»»
  200.  
  201. 10.
  202.         YESTERDAY                    TODAY                    TOMORROW
  203. »»»»»»»»»»»»*««««««««««««  »»»»»»»»»»»»*««««««««««««  »»»»»»»»»»»»*««««««««««««
  204.  
  205. ══[ THE TODAY.LCL FILE ]══════════════════════════════════════════════════════
  206.  
  207. To customize your display with information of particular interest to your BBS
  208. or immediate area, Birthday will scan for the presence of a file called
  209. TODAY.LCL and include appropriate lines from it if it's found.
  210.  
  211. I have included a sample LOCAL.LCL file with a few birthdays in it.  If you
  212. wish, put this file in your GFILES directory.  The format for the LOCAL.LCL
  213. file is:
  214.  
  215. Column 1  :  Must be a 'B'.
  216. Cols 2-5  :  Month and day as MMDD with leading zeros.
  217. Cols 6-9  :  The full year of the event as four digits.
  218. Column 10 :  A space.
  219. Cols 11-80:  The message to display for this date.
  220.  
  221.                                  -= EXAMPLES =-
  222.  
  223. *mmddyyyy Birthdays
  224. *-------- --------------------------------------------------------------------
  225. B09011875 Edgar Rice Burroughs, novelist
  226. B09021838 Queen Liliuokalani (last queen of Hawaii).
  227. B09021952 Jimmy Connors, tennis star
  228.  
  229. ══[ DAILY EVENT SETUP ]═══════════════════════════════════════════════════════
  230.  
  231. Once you have edited the WWIV.INI file, put "BIRTHDAY.EXE" in your daily event
  232. batch file so it can be processed nightly.
  233.  
  234. ══[ LOGON EVENT SETUP ]═══════════════════════════════════════════════════════
  235.  
  236. If you would like to run Birthday as a logon event, so that your Birthday
  237. lists can be viewed by your users, put "BIRTHDAY.EXE L" in your logon event
  238. batch file, or simply put that line in INIT if you have no other logon events.
  239.  
  240. If you don't currently have a logon event, and want Birthday to automatically
  241. configure INIT to run Birthday at the logon event, type:
  242.  
  243.   BDAYCFG /INSTALL
  244.  
  245. That will add "BIRTHDAY.EXE L" (including full path to the EXE) to INIT.
  246.  
  247. If you use the logon event feature, the BDAY.* files must be place in your
  248. main BBS directory (same directory as your EXE).
  249.  
  250. ══[ CHAIN SETUP ]═════════════════════════════════════════════════════════════
  251.  
  252. If you would like to run Birthday as a chain, use the following setup:
  253.  
  254.     A. Description  : Birthday Listings
  255.     B. Filename     : BIRTHDAY.EXE L
  256.     E. ANSI         : Optional
  257.     F. DOS Interrupt: Used
  258.     H. Shrink       : No
  259.     I. Disable pause: No
  260.     J. Local only   : No
  261.  
  262. ┌────────────────────────────────────────────────────────────────────────────┐
  263. │░░░░ COPYRIGHT/LICENSE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  264. └────────────────────────────────────────────────────────────────────────────┘
  265.  
  266. This document and the program files ("the software") are copyrighted by the
  267. author.  The copyright owner hereby licenses you to use the software given
  268. these restrictions:
  269.  
  270.     ■ The software shall be supplied in its original, unmodified form, which
  271.       includes this documentation;
  272.  
  273.     ■ The software may not be included or bundled with other goods or
  274.       services;
  275.  
  276.     ■ No fee is charged; an exception is granted to non-profit user's
  277.       groups, which are permitted to charge a small fee (not to exceed $5)
  278.       for materials, handling, postage, and general overhead.  No other
  279.       organization is permitted to charge any amount for distribution of
  280.       copies of the software or documentation, or to include copies of the
  281.       software or documentation with sales of their own products.
  282.  
  283. The software and documentation are Copyright (c) 1992-1994 by Cris McRae
  284.  
  285. ┌────────────────────────────────────────────────────────────────────────────┐
  286. │░░░░ REGISTRATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  287. └────────────────────────────────────────────────────────────────────────────┘
  288.  
  289. Birthday is shareware.  This gives the user an opportunity to evaluate the
  290. program before actually registering the software.  If, after a 30 day period,
  291. you wish to continue to use Birthday, you are required to register your copy
  292. of Birthday with the author.  To register, please fill out REGISTER.TXT and
  293. send it to:
  294.  
  295.     Cris McRae
  296.     P.O. Box 1351
  297.     Burbank, CA  91507
  298.  
  299. Registration is $5.00 US per copy of Birthday.
  300.  
  301. Note:  Registration system used is REGKEY.
  302.  
  303. ┌────────────────────────────────────────────────────────────────────────────┐
  304. │░░░░ DISCLAIMER ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  305. └────────────────────────────────────────────────────────────────────────────┘
  306.  
  307. The author makes no warranties, expressed or implied, as to the quality or
  308. performance of this program.  Your use of this program constitutes your
  309. release of the author from liability or litigation for any indirect or
  310. consequential damages arising from the use of this program or its associated
  311. files.
  312.  
  313. In no event will the author be liable to you for any damages, including any
  314. lost profits, lost savings or other incidental or consequential damages
  315. arising out of your use or inability to use the program, or for any claim by
  316. any other party.
  317.  
  318. ┌────────────────────────────────────────────────────────────────────────────┐
  319. │░░░░ REVISIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  320. └────────────────────────────────────────────────────────────────────────────┘
  321.  
  322. Version 1.00 (11/01/92)
  323.   ■ Initial release
  324.  
  325. Version 1.01 (11/06/92)
  326.   ■ Fixed color bug
  327.   ■ Changed ASCII output file to BIRTHDAY.MSG for WWIV printfile
  328.     compatibility
  329.   ■ Optimized C code a little
  330.  
  331. Version 1.02 (01/23/93)
  332.   ■ Compiled with WWIV v4.22 userrec format
  333.   ■ Program display updated to implement direct screen writes
  334.   ■ DESQview aware - direct screen writes are turned off under DESQview
  335.  
  336. Version 1.10 (06/10/93)
  337.   ■ Added color configurability
  338.   ■ Added logon event capability
  339.   ■ Added TODAY.xxx support
  340.   ■ Added small registration fee
  341.  
  342. Version 1.11 (06/26/93)
  343.   ■ Fixed color bug (evident when using color 4)
  344.   ■ Added logon event install feature
  345.  
  346. Version 1.12 (09/08/93)
  347.   ■ WWIV v4.23 multi-instance compatible
  348.     (Thanks to Jim Wire)
  349.   ■ Fixed bug where names >24 characters messed up display
  350.   ■ Added logon event ability to print Happy Birthday message to user when
  351.     they logon the day of their birthday
  352.   ■ Added configurable ability to add user numbers after user names in listing
  353.  
  354. Version 1.13 (12/01/93)
  355.   ■ Changed the WWIV v4.23 multi-instance code.  Now uses Wayne Bell's
  356.     file sharing disk I/O routines.
  357.   ■ Added ability to give gold to users on their birthday.
  358.   ■ Added ability to give filepoints to users on their birthday.
  359.   ■ Added ability to give extra time to users on their birthday.  They must
  360.     log on the day of their birthday to get the time.  The extra time is only
  361.     given on their FIRST logon of that day.  This is for WWIV v4.23 users
  362.     only.
  363.  
  364. Version 1.14 (12/18/93)
  365.   ■ Due to unknown causes, the gold, file points, and extra time features
  366.     caused certain systems to lock up.  These features have been removed.
  367.     It is uncertain whether they will be added later or not.
  368.  
  369. Version 1.15 (01/10/94)
  370.   ■ Fixed alignment problem in celebrity birthday listings
  371.   ■ Fixed halting problem during logon event.  Previous v4.23 compatible
  372.     versions opened the USER.LST and kept it open when it was not necessary,
  373.     causing other instances to halt until Birthday was done printing the
  374.     birthday list.  This has been fixed.
  375.   ■ Fixed user screen height problem.  Instead of using the user's screen
  376.     height, prior versions used the BBS's screen height to determine the
  377.     number of lines to print before displaying [PAUSE] during the logon
  378.     event.
  379.  
  380. Version 1.16 (02/20/94)
  381.   ■ Fixed problem reading the USER.LST to see if it was the current users
  382.     birthday during the logon event.  It would only work if the user number
  383.     was 32 or below.
  384.   ■ Fixed problem handling TODAY files that use the 'C' identifier to continue
  385.     an entry on the next line.
  386.     (Bug found by Spackle)
  387.   ■ Fixed problem with printing out birthday lists that don't exist.  For
  388.     instance, if you set up Birthday not to generate an ASCII file, and an
  389.     ASCII user logged on, Birthday would print out an error message because
  390.     it tried to open a non-existent file.  Birthday now prints nothing if it
  391.     cannot find the file.
  392.     (Bug found by FireWalker)
  393.  
  394. Version 1.17 (06/29/94)
  395.   ■ Fixed /INSTALL problem.  It was not properly updating CONFIG.DAT.
  396.   ■ Added support for configurable headers.
  397.   ■ Added support for WWIV.INI.  Birthday no longer uses BIRTHDAY.CFG.
  398.   ■ Changed the way user numbers are handled if you have Birthday append them
  399.     to user names.  Prior versions would not include the number if the name
  400.     was too long.  Birthday now shortens the length of the user name to fit
  401.     the user number in.
  402.   ■ Added configuration program (BDAYCFG.EXE).  You must run BDAYCFG.EXE if
  403.     upgrading from previous versions in order to convert your BIRTHDAY.CFG
  404.     file into WWIV.INI format.
  405.  
  406. ┌────────────────────────────────────────────────────────────────────────────┐
  407. │░░░░ CREDITS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  408. └────────────────────────────────────────────────────────────────────────────┘
  409.  
  410. Birthday is Copyright (c) 1992-1994 by Cris McRae
  411. WWIV is Copyright (c) 1988-1994 by Wayne Bell
  412. PKZIP is Copyright (c) 1989-1994 by PKWARE Inc.
  413. REGKEY is Copyright (c) 1992 by Brian Pirie
  414. IniFile Class is Copyright (c) 1993-1994 by Matt Hucke
  415.  
  416. If you have any comments or questions about this program, you can reach me
  417. at the following network addresses:
  418.  
  419.     TerraNET : 1@1
  420.     WWIVnet  : 1@3809
  421.     IceNET   : 1@8857
  422.     SOLARnet : 1@8857
  423.     TARDISNet: 1@8857
  424.     WWIVLink : 1@18857
  425.     Internet : cris@bluethun.quake.com
  426.  
  427. If you are a sysop on one of the above WWIV networks, you may also subscribe
  428. to my support sub.  The sub name is "JAFO's Software Support".  The sub type
  429. is JAFOSUP.
  430.  
  431. You may also call my BBS system:
  432.  
  433.                               Blue Thunder BBS
  434.                          USR 16.8 HST Dual Standard
  435.                                Open 24 Hours
  436.                                (818)848-4101
  437.